//
// MudTools.OfficeInterop 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

namespace MudTools.OfficeInterop.Word;

/// <summary>
/// Word 文档列表模板集合接口
/// </summary>
public interface IWordListTemplates : IDisposable, IEnumerable<IWordListTemplate>
{
    /// <summary>
    /// 获取应用程序对象。
    /// </summary>
    IWordApplication Application { get; }

    /// <summary>
    /// 获取父对象。
    /// </summary>
    object Parent { get; }

    /// <summary>
    /// 获取列表模板数量。
    /// </summary>
    int Count { get; }

    /// <summary>
    /// 通过索引获取列表模板。
    /// </summary>
    IWordListTemplate this[int index] { get; }

    /// <summary>
    /// 通过名称获取列表模板。
    /// </summary>
    IWordListTemplate this[string name] { get; }

    /// <summary>
    /// 添加新的列表模板。
    /// </summary>
    /// <param name="outlineNumbered">是否为大纲编号。</param>
    /// <param name="builtIn">是否为内置模板。</param>
    /// <returns>新创建的列表模板。</returns>
    IWordListTemplate Add(bool outlineNumbered, bool builtIn);

    /// <summary>
    /// 判断是否存在指定名称的列表模板。
    /// </summary>
    /// <param name="name">列表模板名称。</param>
    /// <returns>是否存在。</returns>
    bool Contains(string name);

    /// <summary>
    /// 获取所有列表模板名称列表。
    /// </summary>
    /// <returns>列表模板名称列表。</returns>
    List<string> GetNames();
}